Class FlowMonitorDataImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.FlowMonitorDataImpl
All Implemented Interfaces:
IPCObject, FlowMonitorData

public class FlowMonitorDataImpl extends IPCObjectImpl implements FlowMonitorData
Information provided by the PKI file:

    \class FlowMonitorData
    
    \brief FlowMonitorData tracks a monitor that has been assigned to an interface.
    
    \example network().getDevice("Router0").getNetflowMonitorManager().getMonitorAt(0).getInterfaceInput("FastEthernet0/0", false)
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getDirection

      public NetflowDirection getDirection()
      Information provided by the PKI file:
      
          \brief Returns the direction of the flow.
          
          \return Netflow::ENetflowDirection, the direction of the flow.
          Flow directions:    eInput = 0,
          eOutput = 1,
          eInputOutput = 2
          
              
      Specified by:
      getDirection in interface FlowMonitorData
      Returns:
      NetflowDirection Returns a NetflowDirection
    • setDirection

      public void setDirection(NetflowDirection direction)
      Information provided by the PKI file:
      
          \brief Sets the direction of the flow.
          
          \param direction,   the direction of the flow.
          Flow directions:    eInput = 0,
          eOutput = 1,
          eInputOutput=2
          
              
      Specified by:
      setDirection in interface FlowMonitorData
      Parameters:
      direction - Takes in a parameter of direction
    • getInterfaceName

      public String getInterfaceName()
      Information provided by the PKI file:
      
          \brief Returns the name of the interface.
          
          \return string, the name of the interface.
          
              
      Specified by:
      getInterfaceName in interface FlowMonitorData
      Returns:
      String Returns a String
    • getFlowCount

      public int getFlowCount()
      Information provided by the PKI file:
      
          \brief Returns the number of flows.
          
          \return string, the number of flows.
          
              
      Specified by:
      getFlowCount in interface FlowMonitorData
      Returns:
      int Returns a int
    • getFlowAt

      public NetflowFlow getFlowAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the flow at the specified index.
          
          \param index, the index of the flow of interest.
          
          \return NetflowFlow, the NetflowFlow object at the specified index.
          
              
      Specified by:
      getFlowAt in interface FlowMonitorData
      Parameters:
      index - Takes in a parameter of index
      Returns:
      NetflowFlow Returns a NetflowFlow
    • getTotalFlowCount

      public int getTotalFlowCount()
      Information provided by the PKI file:
      
          \brief Returns the total number of flows that were created by this monitor on this interface.
          
          \return int, the total number of flows that were created by this monitor on this interface.
          
              
      Specified by:
      getTotalFlowCount in interface FlowMonitorData
      Returns:
      int Returns a int
    • getWaterMarkCount

      public int getWaterMarkCount()
      Information provided by the PKI file:
      
          \brief Returns the number of watermarks.
          
          \return int, the number of watermarks.
          
              
      Specified by:
      getWaterMarkCount in interface FlowMonitorData
      Returns:
      int Returns a int
    • getInactiveExpireCount

      public int getInactiveExpireCount()
      Information provided by the PKI file:
      
          \brief Returns the total number of flows that were closed due to inactivity.
          
          \return int, the total number of flows that were closed due to inactivity.
          
              
      Specified by:
      getInactiveExpireCount in interface FlowMonitorData
      Returns:
      int Returns a int
    • getActiveExpireCount

      public int getActiveExpireCount()
      Information provided by the PKI file:
      
          \brief Returns the total number of flows that were closed due to long activity.
          
          \return int, the total number of flows that were closed due to long activity.
          
              
      Specified by:
      getActiveExpireCount in interface FlowMonitorData
      Returns:
      int Returns a int
    • isIpv6

      public boolean isIpv6()
      Information provided by the PKI file:
      
          \brief Returns true if this flow monitor data is IPv6, otherwise false.
          
          \return bool, true if this flow monitor data is IPv6, otherwise false.
          
              
      Specified by:
      isIpv6 in interface FlowMonitorData
      Returns:
      boolean Returns a boolean
    • isSameMonitor

      public boolean isSameMonitor(String intName, boolean isIpv6)
      Information provided by the PKI file:
      
          \brief Returns true if the specified interface is the same flow monitor data, otherwise false.
          
          \param intName,     intName can be one of the following plus an interface number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          \param isIpv6, true if IPv6, false if IPv4.
          
          \return bool, true if the specified interface is the same flow monitor data, otherwise false.
          
              
      Specified by:
      isSameMonitor in interface FlowMonitorData
      Parameters:
      intName - Takes in a parameter of intName
      isIpv6 - Takes in a parameter of isIpv6
      Returns:
      boolean Returns a boolean
    • hasInput

      public boolean hasInput()
      Information provided by the PKI file:
      
          \brief Returns true if this flow monitor data has input, otherwise false.
          
          \return bool, true if this flow monitor data has input, otherwise false.
          
              
      Specified by:
      hasInput in interface FlowMonitorData
      Returns:
      boolean Returns a boolean
    • hasOutput

      public boolean hasOutput()
      Information provided by the PKI file:
      
          \brief Returns true if this flow monitor data has output, otherwise false.
          
          \return bool, true if this flow monitor data has output, otherwise false.
          
              
      Specified by:
      hasOutput in interface FlowMonitorData
      Returns:
      boolean Returns a boolean
    • getFlowMonitor

      public FlowMonitor getFlowMonitor()
      Information provided by the PKI file:
      
          \brief Returns the flow monitor associated with this flow monitor data.
          
          \return FlowMonitor, the FlowMonitor object associated with this flow monitor data.
          
              
      Specified by:
      getFlowMonitor in interface FlowMonitorData
      Returns:
      FlowMonitor Returns a FlowMonitor